Skip to main content

secret

Secret Model​

Represents a confidential key-value pair stored securely, typically for authentication or integration purposes.

name (string) Required​

The identifier or label for the secret.

  • Min length: 1
  • Max length: 127

value (string, Optional)​

The confidential value of the secret. Required for create and update operations; omitted for delete operations.

  • Max length: 255

is_service_key (boolean, Optional, Write-only)​

When true, the secret is stored and looked up using the service-key naming convention for the tenant. Defaults to false.

Example​

{
  "name": "string",
  "value": "string",
  "is_service_key": false
}